LotusScript Doc

Class: LSAPostalAddresseS

Manages the postal addresses and the correspondence information of an contact or organization unit.

Version:
1.2.6, 04.AUG.2000
History:
04.AUG.2000RGRrecalcCorrespondence doesn't handle empty opening, closing and label types
03.AUG.2000RGRsaveToPredefinedFields has to be adopted to changes in getDefaultItem
02.AUG.2000RGRsetDefaultItem and getDefaultItem changed
27.JUL.2000RGRproperty GetDefaultPostalAddress changed
08.JUN.2000RGRDelete method modified to delete child objects
31.MAY.2000RGRproperties label,closing. and opening changed to use new functionality
31.MAY.2000RGRmethods setAutoRefreshed and recalcCorrespondence added



Property Summary
Public Property Set AddrDataID As String
Public Property Get AddrDataID As String
Public Property Get AddrDataInstance As Variant
Public Property Set AutoUpdate As Integer
Public Property Get AutoUpdate As Integer
Public Property Set Closing As String
Public Property Get Closing As String
Public Property Set ClosingType As String
Public Property Get ClosingType As String
Public Property Get Count As Integer
Public Property Get DefaultPostalAddress As String
Public Property Set FormatOrg As String
Public Property Get FormatOrg As String
Public Property Set ItemDelimiter As String
Public Property Get ItemDelimiter As String
Public Property Set Label As String
Public Property Get Label As String
Public Property Set LabelType As String
Public Property Get LabelType As String
Public Property Set ListDelimiter As String
Public Property Get ListDelimiter As String
Public Property Set NotAllowedChars As Variant
Public Property Get NotAllowedChars As Variant
Public Property Set Opening As String
Public Property Get Opening As String
Public Property Set OpeningType As String
Public Property Get OpeningType As String
Public Property Get PostalAddressDefaultS As Variant
Public Property Get PostalAddresseS As Variant
Public Property Get PostalAddressKeyS As Variant
Public Property Get PostalAddressList As Variant

Method Summary
Sub AddItem (newItem As LSAPostalAddress)
Sub ClearAllItems ()
Sub ClearCurrentItem ()
Sub Delete ()
Sub Explode (SerialDataArr As Variant)
Function fillFromDocS (parentdoc As NotesDocument) As Integer
Function getAddressData () As String
Function GetCurrentItem () As LSAPostalAddress
Function GetDefaultItem () As LSAPostalAddress
Function GetFirstItem () As LSAPostalAddress
Function getInternalCorrespondenceData () As Variant
Function GetItemByKey (ItemKey As String, MoveCurrentItem As Integer) As LSAPostalAddress
Function GetNextItem () As LSAPostalAddress
Function GetPreviousItem () As LSAPostalAddress
Function isAutoRefreshed () As Integer
Function isCorrespondenceCalculated () As Integer
Function IsDefault (CompareItem As LSAPostalAddress) As Integer
Sub New (addrDataID As String)
Sub recalcCorrespondence ()
Function SaveToPredefinedFields (doc As NotesDocument) As Integer
Sub SaveToResponses (parentdoc As NotesDocument)
Sub setAutoRefreshed (newValue As Integer)
Sub setCorrespondenceCalculated (newValue As Integer)
Sub SetCurrentItem (newCurrentItem As LSAPostalAddress)
Sub SetDefaultItem (newDefaultItem As LSAPostalAddress)
Sub UpdateCurrentItem (UpdateItem As LSAPostalAddress)

Property Detail

Public Property Set AddrDataID AsString

Sets the Instance ID of the LSAAddressData object. If this ID isn't available then the properties Label, Opening and Closing cannot be computed correctly because the property DefaultData of the class isn't available. The ID is set by the object LSAAddressData when this object is accessed via the Property "PostalAddresses" of the class LSAAddressData.

Summmary Top

Public Property Get AddrDataID AsString

Summmary Top

Public Property Get AddrDataInstance AsVariant

If the property AddressDataID is set to an correct Instance ID of the LSAAddressData object which can be obtained by the instance manager class this property returns a handle to object.

Summmary Top

Public Property Get DefaultPostalAddress AsString

Returns the formatted information about the default postal address of the contact or organizational unit.Unlike the other lists the default postal address could be an address not maintained in this list! The string is empty if the default item doesn't exit.

History:
27.JUL.2000RGRif default item is nothing then empty string is returned
Summmary Top

Public Property Get PostalAddressList AsVariant

Returns an array of serial data strings. Each entry corresponds to a postal address in the NamedList class and can be used to explode the list.

Summmary Top

Public Property Get PostalAddressKeyS AsVariant

Returns an array of string with the keysof the postal addresses maintained in the list

Summmary Top

Public Property Get PostalAddresseS AsVariant

This property returns an array of string with the the formatted postal addresses (view index) maintained in the list

Summmary Top

Public Property Get PostalAddressDefaultS AsVariant

Returns an array of strings. On the position of the DefaultItem of the list the value is "x"

Summmary Top

Public Property Get Count AsInteger

Returns the number of elements in the list.

Summmary Top

Public Property Set LabelType AsString

Sets the name of the label type which is used to format the label of the default postal address in the correspondence module

Summmary Top

Public Property Get LabelType AsString

Summmary Top

Public Property Set ClosingType AsString

Sets the name of the closing type which is used to format the close of the default postal address in the correspondence module

Summmary Top

Public Property Get ClosingType AsString

Summmary Top

Public Property Set OpeningType AsString

Returns the name of the opening type which is used to format the opening of the default postal address in the correspondence module

Summmary Top

Public Property Get OpeningType AsString

Summmary Top

Public Property Set FormatOrg AsString

Summmary Top

Public Property Get FormatOrg AsString

Summmary Top

Public Property Set AutoUpdate AsInteger

This property is used to switch on and off the automatic update of the label formatting in the correspondence module

Summmary Top

Public Property Get AutoUpdate AsInteger

Summmary Top

Public Property Set Label AsString

The formatted default address of a contact or organization unit

Summmary Top

Public Property Get Label AsString


History:
31.MAY.2000RGRchanged to use recalcCorrespondence
Summmary Top

Public Property Set Opening AsString

Set the opening which should used for the contact or organization in a letter.

Summmary Top

Public Property Get Opening AsString


History:
31.MAY.2000RGRchanged to use recalcCorrespondence
Summmary Top

Public Property Set Closing AsString

Set the Closing which should used for the contact or organization in a letter.

Summmary Top

Public Property Get Closing AsString


History:
31.MAY.2000RGRchanged to use recalcCorrespondence
Summmary Top

Public Property Set ListDelimiter AsString

When the object is imploded to a serial data string this character will be used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get ListDelimiter AsString

Summmary Top

Public Property Set ItemDelimiter AsString

When the an item is imploded to a serial data string this character will be used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get ItemDelimiter AsString

Summmary Top

Public Property Set NotAllowedChars AsVariant

These characters are not allowed to be use in the items

Summmary Top

Public Property Get NotAllowedChars AsVariant

Summmary Top
Method Detail

New

Public Sub New(addrDataID As String)
Initialzes the internal NamedLists.

Summmary Top

Delete

Public Sub Delete
Default destructor of the class. Deletes all child objects.

History:
08.JUN.2000RGRChild objects are deleted.
Summmary Top

AddItem

Public Sub AddItem(newItem As LSAPostalAddress)
Adds a new postal address to the list

Parameters:
newItemLSAPostalAddressthe new postal address object which should be added to the list
Summmary Top

ClearCurrentItem

Public Sub ClearCurrentItem
Deletes the current item from the list

Summmary Top

ClearAllItems

Public Sub ClearAllItems
Reinitializes the postal address list

Summmary Top

UpdateCurrentItem

Public Sub UpdateCurrentItem(UpdateItem As LSAPostalAddress)
Updates the current item with the data from the UpdateItem

Parameters:
updateItemLSAPostalAddressitem storing the update information
Summmary Top

IsDefault

Public Function IsDefault(CompareItem As LSAPostalAddress) As Integer
Checks if the parameter item is the default item of the list.

Parameters:
compareItemLSAPostalAddressthe item the object is compared with
Returns:
Booleantrue, if the item is the default item
Summmary Top

SetCurrentItem

Public Sub SetCurrentItem(newCurrentItem As LSAPostalAddress)
Set the current item to the parameter item

Parameters:
newCurrentItemLSAPostalAddressthe item which should be used as current item
History:
04.AUG.2000RGRnothing as currentItem was handled correctly
Summmary Top

SetDefaultItem

Public Sub SetDefaultItem(newDefaultItem As LSAPostalAddress)
Set the default item to the parameter item

Summmary Top

GetItemByKey

Public Function GetItemByKey(ItemKey As String,MoveCurrentItem As Integer) As LSAPostalAddress
Summmary Top

GetDefaultItem

Public Function GetDefaultItem As LSAPostalAddress
Returns the default item of the list. If the item hasn't been set with the function setDefaultItem "Nothing" is returned.

Returns:
LSAPostalAddressthe default item
History:
02.AUG.2000RGRnothing is returned if the function setDeafultItem hasn't be used
02.AUG.2000RGRcheck if the default item is in the list and refresh acccordingly
Summmary Top

GetCurrentItem

Public Function GetCurrentItem As LSAPostalAddress
Returns the current item of the list

Returns:
LSAPostalAddressitem which the current pointer is pointing at
Summmary Top

GetFirstItem

Public Function GetFirstItem As LSAPostalAddress
Returns the first item of the list

Returns:
LSAPhoneItemthe first item in the list
Summmary Top

GetNextItem

Public Function GetNextItem As LSAPostalAddress
Returns the item next to the current item of the list.

Returns:
LSAPhoneItemnext item to the current item
Summmary Top

GetPreviousItem

Public Function GetPreviousItem As LSAPostalAddress
Summmary Top

getInternalCorrespondenceData

Public Function getInternalCorrespondenceData As Variant
Returns the internal not freshly calculated values Label, Opening and Closing.

Summmary Top

SaveToPredefinedFields

Public Function SaveToPredefinedFields(doc As NotesDocument) As Integer
This function stores the properties of the class to some predefined fields as defined by the plug&play design elements of LSA-Address. If the parameter save default is true the information of the default postal address is stored in the document, otherwise the person or organizational unit uses postal address from another person or organizational unit as default. The parameter doc identifies the (main) document where the data is stored.

Parameters:
docNotesDocumentThe document which correspond to the unit.
Returns:
IntegerTrue, if an item in the document has been changed, false else
History:
03.AUG.2000RGRGetDefaultItem = Nothing wasn't handled correctly
Summmary Top

Explode

Public Sub Explode(SerialDataArr As Variant)
Fills the list with the serialized object provided by the parameter array

Summmary Top

fillFromDocS

Public Function fillFromDocS(parentdoc As NotesDocument) As Integer
This method is specific for the need of LSAAddr and LSAOrga. Therefore will use fieldnames and internal knowledge of class

Summmary Top

SaveToResponses

Public Sub SaveToResponses(parentdoc As NotesDocument)
This method saves the postal address list to response documents

Summmary Top

isCorrespondenceCalculated

Public Function isCorrespondenceCalculated As Integer
Indicates if the correspondence data (label, opening and closing) is currently calculated. Because this switch is used by the class LSAAddressData the function has to be public. In Java this would be a protected function. This function should not be used by external functions !!!

See also:
LSALibAddressData.LSAAddressData#GetDefaultData
Summmary Top

setCorrespondenceCalculated

Public Sub setCorrespondenceCalculated(newValue As Integer)

See also:
LSALibPostalAddresseS.LSAPostalAdresseS#isCorrespondenceCalculated
Summmary Top

isAutoRefreshed

Public Function isAutoRefreshed As Integer
Indicates if the correspondence data (label, opening and closing) is calculated everytime one of the properties label, opening or closing is called or if the function recalcCorrespondence must be triggered manually. Because This function should be used by external functions!

See also:
LSALibAddressData.LSAAddressData#GetDefaultData
Summmary Top

setAutoRefreshed

Public Sub setAutoRefreshed(newValue As Integer)

See also:
LSALibPostalAddresseS.LSAPostalAddresseS#isAutoRefreshed
Summmary Top

recalcCorrespondence

Public Sub recalcCorrespondence
Does the calculation of the three properties label, opening and closing. Don't use this function, use the properties instead.

History:
04.AUG.2000RGRrecalcCorrespondence doesn't handle empty opening, closing and label types
Summmary Top

getAddressData

Public Function getAddressData As String
Calcualtes the LotusA datablock which is inserted into DefaultData

Returns:
astring of the form ##LotusA############
Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:45:34 AM